home *** CD-ROM | disk | FTP | other *** search
/ Collection of Tools & Utilities / Collection of Tools and Utilities.iso / bbsutil / sfued108.zip / README17.SFU < prev    next >
Text File  |  1992-05-29  |  19KB  |  396 lines
  1.  
  2.               StormFront User Editor for the Opus CBCS
  3.                    Copyright 1992 by Kevin Silcox
  4.  
  5.                                                            May 29, 1992
  6.  
  7. Disclaimer
  8. ----------
  9.     This software is available "AS IS".  It is not guaranteed to work at
  10. all. If it trashes your system or ruins your life, you have been warned.
  11. I am not responsible for any damages incurred from the use or misuse of
  12. this software.  There is also no fee to use this software to keep with
  13. the spirit of Opus.
  14.  
  15.     You will have to get by without any real documentation until I, or
  16. someone else writes some for this program.  If you know Opus and how it
  17. works, then this program should be pretty much self-explanatory as far
  18. as what the actual changes to the user database do.  So for now, there's
  19. only a brief description of how to use the actual functions of the program.
  20. Even though SFUE17 doesn't have the most user-friendly interface, I think
  21. that its flexibility is worth the struggle you *may* go through when you
  22. first start to use it.  Enjoy!
  23.  
  24.   WARNING: If you're running Opus in a multi-tasking environment then make
  25.   sure that you DO NOT Sort or Zap the database when there is a potential
  26.   for Opus to need to use the user database! (i.e. If a user calls and
  27.   tries to login.)
  28.  
  29.  
  30. --=={*-------------------------------------------------*}==--
  31.     This version: 1.08  --->  For Opus v1.7x
  32.  
  33.     Requires approximately 125K of Available RAM.  Requires
  34.     more if using the Sort option (based on number of records
  35.     in your database --> about 28 bytes for each record, up to
  36.     a maximum of about 2300 records, plus 8 bytes per CWF). The
  37.     maximum memory requirement should be about 200K.
  38.  
  39. **> I recommend you use an EXE compressor such as PKlite in
  40.     order to reduce the program size. (About 52% with PKlite v1.13)
  41.  
  42.     This program is for maintaining the user database used with
  43. Opus.  It is capable of adding users, marking them to be ReUsed,
  44. Purged, Normal, and even Removing users marked to be Purged (Zap),
  45. along with many other nifty features.
  46.  
  47. -*-
  48.     The program accepts a command-line argument for local and non-
  49. local use.  Entering an argument other than those arguments listed
  50. will display a brief help screen.  The arguments are as follows:
  51.  -M force Mono mode              -C force Color mode     -A AutoDetect
  52.  -D force DOS Output             -B force BIOS Writes
  53.  -U to use a specific User file  -Z to Zap the database
  54.  -X Translate IBM Graphics to    -I Install defaults
  55.     Normal characters
  56.  
  57.     The -M and -C options are only to force the memory address for the
  58. direct-screen writes if the program doesn't recognize the correct video
  59. mode.  If no arguments are entered, the program will AutoDetect which
  60. video mode to use for the direct-screen writes.  If you use the DOS
  61. option then I/O may be redirected.
  62.     The -U allows you to specify the name of the User Database file
  63. that you want to use instead of the default USER.DAT.  If you specify
  64. just the full path without a filename, USER.DAT will be assumed (you
  65. must have a "\" after the path though).
  66.     You may either use the -X (Translate) option from the command-line,
  67. or use CTRL-X to toggle IBM Graphics translation ON and OFF from the
  68. user edit screen. NOTE: When translation is turned ON, the IBM Graphics
  69. characters in the Report will be translated also.
  70.     Use -I to change the default parameters.  NOTE: Not all parameters
  71. saved in the INI file get priority.  For example, if the OPUS environment
  72. variable is pointing to a PRM file, it will be used instead of the name
  73. stored in the INI file.  The INI file is mainly used as a backup method
  74. to locate all the files it needs.
  75.  
  76. *--===--*
  77.  
  78.     Whenever there has been a modification to the current user record,
  79. SFUE17 will place an asterisk '*' at the top right-hand side of the
  80. screen.  There are two things that SFUE17 *may* change automatically.
  81. If the number of times a user has called the system is zero (0), it will
  82. be changed to one (1).  Also, if the user has QkMenu (Return to Last
  83. Menu) turned on, SFUE17 will try to make sure the menu is valid to prevent
  84. Opus from choking. :-)
  85.  
  86.     There are now two new indicators in ScrnSect 1 (as of v1.08).  The
  87. one that you probably won't see is the '[COPY]' indicator.  This indicates
  88. that you are NOT currently editing the database that Opus uses.  If you
  89. are editing the actual database that Opus uses, then you won't see the
  90. '[COPY]'.  The other indicator is '*CWF*' which indicates that the user
  91. being displayed has a CWF file in the Opus root directory (#.?BS).  This
  92. is displayed whether you're editing a copy of the database or the real one.
  93.  
  94.     When using the Inactivity timer, the program will beep at 5 second
  95. intervals starting 20 seconds before exiting.
  96.  
  97. **==--==**
  98.  
  99.  ** NOTE:  SFUE17 will always try to show the users' Real Name in
  100.         the Name field and their Alias in the Alias field as of
  101.         v1.08 (based on the information in the PRM file).
  102.  
  103.     In the lower right-hand corner of the User Screen are the commands
  104. that are available in all ScreenSections.  Below is a brief description
  105. of what they do:
  106.  
  107.     R)  Record Number:  This allows you to go to a specific record number
  108.         within the database.
  109.  
  110.     !)  User Status:  This allows you to modify the status of a user's
  111.         record.  The Status can be one of the following:
  112.             Normal: This is a normal record.
  113.             Reuse : As new users are added, they will be placed in records
  114.                      marked with this status instead of being added to the
  115.                      end of the database.
  116.             Purge : This means that if you use the Zap function, the record
  117.                      will be removed from the database.  Also used by OMAN.
  118.         Update ID : This will update the caller ID number but should only be
  119.                      used if the caller_ID is all zero's or in conflict with
  120.                      another record.
  121.  
  122.     *)  Utilities:   This is for maintaining the database.  Options are:
  123.             Adduser: If you need to add a user, this is what you'll use.
  124.                       It has gives you the option of just adding a record
  125.                       at the end of the database, or searching for a record
  126.                       marked with the "Reuse" status.  If you choose to
  127.                       search for a record to Reuse, and there is a record
  128.                       marked with the Reuse status, then that record will be
  129.                       cleared of its information and you may start entering
  130.                       the new user information in that record.
  131.  
  132.             Global : Allows you to make certain changes to specific (or all)
  133.                       users.  You may specify to set only a certain privilege
  134.                       level, or the default is all records (record #1 will
  135.                       NOT be touched).  There are also sub-levels that I
  136.                       don't have time to go into.
  137.                       -=***=-
  138.                       I feel that the options for changing Keys and Sections
  139.                       may cause some confusion.  With those two options there
  140.                       are 4 sub-options [Exact/Set/Toggle/Unselect]:
  141.  
  142.                         Exact:    Set each user to exactly the keys you
  143.                                   specify.  If you only select the 'A' key,
  144.                                   that's the only key the users' will have
  145.                                   no matter what they started out with.
  146.                         Set:      All keys you specify will be turned ON for
  147.                                   each user.
  148.                         Toggle:   Exactly what it says...  If you select the 'A'
  149.                                   key each users' keys will be set to the
  150.                                   opposite it started out as.
  151.                         Unselect: The opposite of Set.  It will make sure each
  152.                                   key you select is turned OFF.
  153.  
  154.             Import : This is if you want to add t